Skip to content

Let's remove generation help.1 to container#421

Merged
phracek merged 1 commit intomasterfrom
remove_golang
Mar 13, 2026
Merged

Let's remove generation help.1 to container#421
phracek merged 1 commit intomasterfrom
remove_golang

Conversation

@phracek
Copy link
Member

@phracek phracek commented Mar 11, 2026 •
edited by github-actions bot
Loading

Let's remove generation help.1 to container completelly.

I would prefer also add into each container
file called 'USAGE.md' from 'README.md'

I would like to avoid duplication from README.md

Summary by CodeRabbit

  • Chores
    • Simplified the build pipeline by removing automatic help documentation file generation from the version build process.

@phracek
Let's remove generation help.1 to container
70a37a2 
completelly.

I would prefer also add into each container
file called 'USAGE.md' from 'README.md'

I would like to avoid duplication from README.md

Signed-off-by: Petr "Stone" Hracek <phracek@redhat.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

A Makefile change that removes the per-version build dependency on root/help.1. The recipe generating help.1 from README.md via go-md2man is deleted, decoupling help file generation from the version build pipeline.

Changes

Cohort / File(s) Summary
Build Configuration
common.mk		 Removed per-version prerequisite to root/help.1; deleted recipe for generating help.1 from README.md using go-md2man, mkdir, and chmod. Version build targets no longer depend on help file generation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A help file's journey ends today,
No more does it block the build's way,
Versions now run free and fleet,
Without the prerequisite's beat,
The pipeline hops on, light and light! 🌟

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly describes the main change: removing the generation of help.1 from the container build process in common.mk.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch remove_golang
📝 Coding Plan
  • Generate coding plan for human review comments

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link

github-actions bot commented Mar 11, 2026 •
edited
Loading

Pull Request validation

Failed

🔴 Failed or pending statuses:

  • Testing Farm - RHEL10 - s2i-base-container[error]
  • Testing Farm - RHEL8 - s2i-base-container[error]
  • Testing Farm - RHEL9 - s2i-base-container[error]
  • Testing Farm - CentOS Stream 10 - s2i-base-container[error]
  • Testing Farm - CentOS Stream 9 - s2i-base-container[error]
  • Testing Farm - Fedora - s2i-base-container[error]
  • Testing Farm - RHEL9 - s2i-python-container[pending]
  • Testing Farm - CentOS Stream 9 - s2i-python-container[pending]

🔴 Review - Missing review from a member (1 required)

@phracek phracek requested a review from pkhartsk March 13, 2026 10:46
@phracek
Copy link
Member Author

phracek commented Mar 13, 2026

[test]

pkhartsk
pkhartsk approved these changes Mar 13, 2026
View reviewed changes
Copy link
Contributor

@pkhartsk pkhartsk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@github-actions
Copy link

github-actions bot commented Mar 13, 2026 •
edited
Loading

Testing Farm results

namecomposearchstatusstarted (UTC)timelogs
Fedora - nginx-containerFedora-latestx86_64✅ passed13.03.2026 10:46:5612min 28stest pipeline
CentOS Stream 10 - nginx-containerCentOS-Stream-10x86_64✅ passed13.03.2026 10:46:5515min 7stest pipeline
RHEL10 - s2i-base-containerRHEL-10-Nightlyx86_64✅ passed13.03.2026 15:24:5517min 5stest pipeline
RHEL8 - s2i-base-containerRHEL-8.10.0-Nightlyx86_64✅ passed13.03.2026 15:24:5418min 1stest pipeline
RHEL10 - nginx-containerRHEL-10-Nightlyx86_64✅ passed13.03.2026 10:47:3316min 45stest pipeline
RHEL9 - s2i-base-containerRHEL-9.6.0-Nightlyx86_64✅ passed13.03.2026 15:24:5423min 21stest pipeline
CentOS Stream 9 - nginx-containerCentOS-Stream-9x86_64✅ passed13.03.2026 10:46:5518min 30stest pipeline
RHEL8 - nginx-containerRHEL-8.10.0-Nightlyx86_64✅ passed13.03.2026 10:46:5521min 31stest pipeline
CentOS Stream 10 - postgresql-containerCentOS-Stream-10x86_64✅ passed13.03.2026 10:46:5421min 25stest pipeline
CentOS Stream 10 - s2i-perl-containerCentOS-Stream-10x86_64✅ passed13.03.2026 10:46:5623min 45stest pipeline
RHEL9 - nginx-containerRHEL-9.6.0-Nightlyx86_64✅ passed13.03.2026 10:46:5625min 6stest pipeline
RHEL10 - postgresql-containerRHEL-10-Nightlyx86_64✅ passed13.03.2026 10:46:5424min 14stest pipeline
RHEL8 - s2i-perl-containerRHEL-8.10.0-Nightlyx86_64✅ passed13.03.2026 10:46:5627min 11stest pipeline
CentOS Stream 10 - s2i-base-containerCentOS-Stream-10x86_64✅ passed13.03.2026 15:24:5414min 37stest pipeline
CentOS Stream 9 - s2i-base-containerCentOS-Stream-9x86_64✅ passed13.03.2026 15:24:5515min 22stest pipeline
Fedora - s2i-base-containerFedora-latestx86_64✅ passed13.03.2026 15:24:5311min 30stest pipeline
Fedora - postgresql-containerFedora-latestx86_64✅ passed13.03.2026 11:01:3422min 13stest pipeline
Fedora - s2i-perl-containerFedora-latestx86_64✅ passed13.03.2026 10:47:0240min 1stest pipeline
CentOS Stream 9 - s2i-perl-containerCentOS-Stream-9x86_64✅ passed13.03.2026 11:03:2123min 50stest pipeline
RHEL8 - postgresql-containerRHEL-8.10.0-Nightlyx86_64✅ passed13.03.2026 10:46:5542min 43stest pipeline
CentOS Stream 9 - postgresql-containerCentOS-Stream-9x86_64✅ passed13.03.2026 11:03:1530min 41stest pipeline
RHEL9 - s2i-perl-containerRHEL-9.6.0-Nightlyx86_64✅ passed13.03.2026 11:07:1131min 23stest pipeline
RHEL10 - s2i-python-containerRHEL-10-Nightlyx86_64✅ passed13.03.2026 11:06:0341min 14stest pipeline
Fedora - s2i-python-containerFedora-latestx86_64✅ passed13.03.2026 10:46:551h 2min 60stest pipeline
RHEL9 - postgresql-containerRHEL-9.6.0-Nightlyx86_64✅ passed13.03.2026 11:09:1940min 8stest pipeline
CentOS Stream 10 - s2i-python-containerCentOS-Stream-10x86_64✅ passed13.03.2026 10:46:551h 13min 43stest pipeline
RHEL8 - s2i-python-containerRHEL-8.10.0-Nightlyx86_64✅ passed13.03.2026 10:46:551h 32min 44stest pipeline
RHEL9 - s2i-python-containerRHEL-9.6.0-Nightlyx86_64✅ passed13.03.2026 10:46:541h 43min 45stest pipeline
CentOS Stream 9 - s2i-python-containerCentOS-Stream-9x86_64✅ passed13.03.2026 11:03:101h 51min 41stest pipeline

@phracek
Copy link
Member Author

phracek commented Mar 13, 2026

s2i-base-container failure is expected. https://github.com/sclorg/s2i-base-container/blob/master/Makefile#L17

@phracek
Copy link
Member Author

phracek commented Mar 13, 2026

s2i-base-container failure will be fixed by sclorg/s2i-base-container#357

@phracek phracek merged commit 18f0075 into master Mar 13, 2026
35 checks passed
@phracek phracek deleted the remove_golang branch March 13, 2026 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pkhartsk pkhartsk pkhartsk approved these changes

Assignees

No one assigned

Labels

pr/failing-ci pr/missing-review ready for review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@phracek @pkhartsk